Fix/199 attr escape by vinitkumar · Pull Request #222 · vinitkumar/json2xml

vinitkumar · 2024-12-13T12:46:28Z

Fixes #199

Summary by Sourcery

Fix attribute escaping in XML conversion to handle special characters and add corresponding tests to ensure correct functionality.

Bug Fixes:

Fix attribute escaping in XML conversion to handle special characters like angle brackets, quotes, and ampersands.

Tests:

Add tests to verify the correct escaping of special characters in XML attributes, including angle brackets, quotes, ampersands, and mixed special characters.

Following will be escaped from now on - angle brackets - quotes - ampersands - and a mix of them too

sourcery-ai · 2024-12-13T12:46:33Z

Reviewer's Guide by Sourcery

This PR implements XML attribute value escaping in the json2xml package. The implementation modifies the attribute string generation to properly escape special characters like angle brackets, quotes, and ampersands in XML attributes.

Class diagram for updated make_attrstring function

classDiagram
    class DictToXml {
        +make_attrstring(attr: dict[str, Any]) str
    }
    class EscapeUtils {
        +escape_xml(value: str) str
    }
    DictToXml --> EscapeUtils : uses

File-Level Changes

Change	Details	Files
Added XML attribute value escaping in attribute string generation	Modified attribute string generation to use escape_xml() function for attribute values Ensures special characters (<, >, ", &) are properly escaped in XML output	`json2xml/dicttoxml.py`
Added comprehensive test cases for XML attribute escaping	Added test for escaping angle brackets Added test for escaping quote characters Added test for escaping ampersands Added test for escaping mixed special characters	`tests/test_json2xml.py`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#199	Implement XML escaping for special characters in @attrs values	✅

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time. You can also use
this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

codecov · 2024-12-13T12:46:43Z

❌ 4 Tests Failed:

Tests completed	Failed	Passed	Skipped
89	4	85	0

View the top 3 failed tests by shortest run time

tests.test_json2xml.TestJson2xml::test_escapes_mixed_special_chars

Stack Traces | 0.009s run time

self = <tests.test_json2xml.TestJson2xml object at 0x000001fe3b0152b8>

    def test_escapes_mixed_special_chars(self):
        json_data = json.dumps({"root": {"@attrs": {"Text": "<tag> & \"quote\""}}})
        result = json2xml.Json2xml(json_data).to_xml()
>       assert '"Text": "&lt;tag&gt; &amp; \\"quote\\""' in result
E       assert '"Text": "&lt;tag&gt; &amp; \\"quote\\""' in '<?xml version="1.0" encoding="UTF-8"?>\n<all>\n\t<item type="str">{&quot;root&quot;: {&quot;@attrs&quot;: {&quot;Text&quot;: &quot;&lt;tag&gt; &amp; \\&quot;quote\\&quot;&quot;}}}</item>\n</all>\n'

tests\test_json2xml.py:250: AssertionError

tests.test_json2xml.TestJson2xml::test_escapes_quotes

Stack Traces | 0.009s run time

self = <tests.test_json2xml.TestJson2xml object at 0x000001fe3affa368>

    def test_escapes_quotes(self):
        json_data = json.dumps({"root": {"@attrs": {"Text": "\"quoted\""}}})
        result = json2xml.Json2xml(json_data).to_xml()
>       assert '"Text": "\\"quoted\\""' in result
E       assert '"Text": "\\"quoted\\""' in '<?xml version="1.0" encoding="UTF-8"?>\n<all>\n\t<item type="str">{&quot;root&quot;: {&quot;@attrs&quot;: {&quot;Text&quot;: &quot;\\&quot;quoted\\&quot;&quot;}}}</item>\n</all>\n'

tests\test_json2xml.py:240: AssertionError

tests.test_json2xml.TestJson2xml::test_escapes_angle_brackets

Stack Traces | 0.01s run time

self = <tests.test_json2xml.TestJson2xml object at 0x000001fe3affa4b8>

    def test_escapes_angle_brackets(self):
        json_data = json.dumps({"root": {"@attrs": {"HelpText": "version <here>"}}})
        result = json2xml.Json2xml(json_data).to_xml()
>       assert '"HelpText": "version &lt;here&gt;"' in result
E       assert '"HelpText": "version &lt;here&gt;"' in '<?xml version="1.0" encoding="UTF-8"?>\n<all>\n\t<item type="str">{&quot;root&quot;: {&quot;@attrs&quot;: {&quot;HelpText&quot;: &quot;version &lt;here&gt;&quot;}}}</item>\n</all>\n'

tests\test_json2xml.py:235: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

sourcery-ai

Hey @vinitkumar - I've reviewed your changes and they look great!

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

vinitkumar added 3 commits December 13, 2024 18:02

test: add breaking tests

18ce10c

fix: escape attributes

7a12324

Following will be escaped from now on - angle brackets - quotes - ampersands - and a mix of them too

test: add tests to verify what we want to escape is escaped

7f6ff6e

vinitkumar self-assigned this Dec 13, 2024

sourcery-ai bot reviewed Dec 13, 2024

View reviewed changes

fix: ruff lint issues

2b52fa2

vinitkumar closed this Dec 18, 2024

vinitkumar deleted the fix/199-attr-escape branch February 21, 2025 12:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix/199 attr escape#222

Fix/199 attr escape#222
vinitkumar wants to merge 4 commits intomasterfrom
fix/199-attr-escape

vinitkumar commented Dec 13, 2024 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Dec 13, 2024 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

codecov bot commented Dec 13, 2024 •

edited

Loading

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

vinitkumar commented Dec 13, 2024 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Class diagram for updated make_attrstring function

File-Level Changes

Assessment against linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

codecov bot commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ 4 Tests Failed:

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

vinitkumar commented Dec 13, 2024 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Dec 13, 2024 •

edited

Loading

codecov bot commented Dec 13, 2024 •

edited

Loading